home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus Special 23 / AMIGAplus Sonderheft 23 (2000)(Falke)(DE)[!].iso / PublicDomain / Anwendungen / ImageManager / Developer / ImageManager.Doc < prev   
Text File  |  1999-11-10  |  4KB  |  164 lines
  1. TABLE OF CONTENTS
  2.  
  3. ImageManager.library/--introduction--
  4. ImageManager.library/IM_DisposeObject
  5. ImageManager.library/IM_GetClass
  6. ImageManager.library/IM_NewObjectA
  7. ImageManager.library/IM_ObtainColourCube
  8. ImageManager.library/IM_ReleaseColourCube
  9.  
  10. ImageManager.library/--introduction--
  11.  
  12. This is a PRELIMINARY autodoc. Don't expect anything to remain as it currently
  13. is...
  14.  
  15. Feedback: Allan Odgaard <Duff@DIKU.DK>
  16.  
  17. ImageManager.library/IM_GetClass
  18.  
  19.     NAME
  20.         IM_GetClass -- Get a pointer to an IM class.
  21.  
  22.     SYNOPSIS
  23.         class = IM_GetClass(classID)
  24.         D0                  A0
  25.  
  26.         struct IClass *IM_GetClass(STRPTR);
  27.  
  28.      FUNCTION
  29.         Obtain a pointer to the class of a certain classID.
  30.         You need this pointer if you want to create a subclass.
  31.  
  32.    INPUTS
  33.       classID = the name/ID string of a IM class, e.g. "Decoder".
  34.  
  35.    RESULT
  36.       A pointer to the class or NULL for failure.
  37.  
  38.    SEE ALSO
  39.       MakeClass()
  40.  
  41. ImageManager.library/IM_DisposeObject
  42.  
  43.    NAME
  44.       IM_DisposeObject -- Delete an IM object.
  45.  
  46.    SYNOPSIS
  47.       IM_DisposeObject(object)
  48.                        A0
  49.  
  50.       VOID MUI_DisposeObject(Object *);
  51.  
  52.     FUNCTION
  53.       Deletes an IM object and all of it's auxiliary data.
  54.       These objects are all created by IM_NewObject() or NewObject().
  55.  
  56.    INPUTS
  57.       object = abstract pointer to an IM object returned by
  58.                MUI_NewObject(). The pointer may be NULL, in which case
  59.                this function has no effect.
  60.  
  61.    RESULT
  62.       None.
  63.  
  64.    SEE ALSO
  65.       IM_NewObjectA()
  66.  
  67. ImageManager.library/IM_NewObjectA
  68.  
  69.    NAME
  70.       IM_NewObjectA -- Create an object from a class.
  71.       IM_NewObject -- Varargs stub for IM_NewObjectA().
  72.  
  73.    SYNOPSIS
  74.       object = IM_NewObjectA(classID, tags)
  75.       D0                     A0       A1
  76.  
  77.       Object *IM_NewObjectA(STRPTR, struct TagItem *);
  78.  
  79.       object = IM_NewObject(classID, Tag1, ...)
  80.  
  81.       Object *IM_NewObject(STRPTR, ULONG, ...);
  82.  
  83.    FUNCTION
  84.       This is the general method of creating objects from IM classes.
  85.       You specify a class by its ID string. If the class is not
  86.       already in memory or built into imagemanager.library, it will be
  87.       loaded using OpenLibrary("ImageManager/%s",0).
  88.  
  89.       You further specify initial "create-time" attributes for the
  90.       object via a TagItem list, and they are applied to the resulting
  91.       generic data object that is returned. The attributes, their meanings,
  92.       attributes applied only at create-time, and required attributes
  93.       are all defined and documented on a class-by-class basis.
  94.  
  95.    INPUTS
  96.       classID = the name/ID string of a IM class, e.g. "Decoder".
  97.                 Class names are case sensitive!
  98.  
  99.       tagList = pointer to array of TagItems containing attribute/value
  100.                 pairs to be applied to the object being created.
  101.  
  102.    RESULT
  103.       An IM object, which may be used on its own or added to a chain of
  104.       objects for serial processing of (image) data.
  105.       The object may be manipulated by generic functions such as SetAttrs(),
  106.       GetAttr(), DoMethod() etc.
  107.       You eventually free the object using IM_DisposeObject().
  108.  
  109.    SEE ALSO
  110.       IM_DisposeObject(), SetAttrs(), GetAttr().
  111.  
  112. ImageManager.library/IM_ObtainColourCube
  113.  
  114.    NAME
  115.         IM_ObtainColourCube -- Obtain a screen specific colour cube
  116.  
  117.    SYNOPSIS
  118.         cube = IM_ObtainColourCube(screen)
  119.         D0                         A0
  120.  
  121.         APTR IM_ObtainColourCube(struct Screen *);
  122.  
  123.    FUNCTION
  124.         Obtain a colour cube for the specified screen.
  125.  
  126.    INPUTS
  127.         screen = Pointer to the screen for which you want a colour cube.
  128.  
  129.    RESULT
  130.         A blockbox colour cube, which can be used with the remap or
  131.         floyd steinberg dither objects.
  132.  
  133.    SEE ALSO
  134.         IM_ReleaseColourCube()
  135.  
  136. ImageManager.library/IM_ReleaseColourCube
  137.  
  138.    NAME
  139.         IM_ReleaseColourCube -- Release a colour cube object
  140.  
  141.    SYNOPSIS
  142.         IM_ReleaseColourCube(cube)
  143.  
  144.         VOID IM_ReleaseColourCube(APTR)
  145.  
  146.    FUNCTION
  147.         Release a previously obtained colour cube object.
  148.  
  149.    INPUTS
  150.         cube = A colour cube obtained with IM_ObtainColourCube() or NULL.
  151.  
  152.    RESULT
  153.         None.
  154.  
  155.     NOTE
  156.         Releasing a colour cube object for a screen will free all pens that may
  157.         have been locked. So you generally shouldn't free this object, while
  158.         you're displaying image data that makes use of the colours obtained
  159.         through it.
  160.  
  161.    SEE ALSO
  162.         IM_ObtainColourCube
  163.  
  164.